文档(Documents)

[GET] /api/v2/common/documents/download

批量下载文档。

参数

名称	类型	位置	描述
ids	string	query	文档 ID。 例如： ["F00FC3E6-8554-467D-9A7E-4598E623BB2F", "8259E551-5AFB-489E-8593-0FD6384E123B"]

响应

状态代码: 200

成功

二进制

状态代码: 400

错误请求

ServerPluginError

[GET] /api/v2/common/documents/{id}/download

获取文档。

参数

名称	类型	位置	描述
id必填项	string	path	文档 ID。 例如：1E5D7247-450E-4383-B0DD-09D5CF651907
rev	int32	query	文档修订。 例如：null 或 1

响应

状态代码: 200

成功

二进制

状态代码: 400

错误请求

ServerPluginError

状态代码: 404

未发现

ServerPluginError

[PUT] /api/v2/common/documents/thumbnails/{id}/upload

上传文档缩略图。

参数

名称	类型	位置	描述
id必填项	string	path	文档 ID。 例如：1E5D7247-450E-4383-B0DD-09D5CF651907

响应

状态代码: 200

成功

ThumbnailUploadResponseModel

状态代码: 400

错误请求

ServerPluginError

[DELETE] /api/v2/common/documents/thumbnails/{id}/delete

删除指定的文档缩略图。

参数

名称	类型	位置	描述
id必填项	string	path	文档ID。 例如：1E5D7247-450E-4383-B0DD-09D5CF651907

响应

状态代码: 204

成功

状态代码: 400

错误请求

ServerPluginError

状态代码: 404

未发现

ServerPluginError

[PUT] /api/v2/common/documents/{id}/referenced-documents/update

更新依赖于指定文档的文档，以引用指定文档的最新版本。

参数

名称	类型	位置	描述
id必填项	string	path	指定文档ID。 例如：1E5D7247-450E-4383-B0DD-09D5CF651907

响应

状态代码: 204

成功

状态代码: 400

错误请求

ServerPluginError

状态代码: 404

未发现

ServerPluginError

[DELETE] /api/v2/common/documents/{id}/delete

删除文档。

参数

名称	类型	位置	描述
id必填项	string	path	文档ID。 例如：1E5D7247-450E-4383-B0DD-09D5CF651907

请求模式

DocumentModel+DocumentDeleteRequestModel

响应

状态代码: 200

成功

DocumentResponseModel

状态代码: 400

错误请求

ServerPluginError

状态代码: 404

未发现

ServerPluginError

[DELETE] /api/v2/common/documents/batch-delete

批量删除文档。

请求模式

DocumentModel+BatchDeleteDocumentsRequestModel

响应

状态代码: 200

成功

DocumentResponseModel

状态代码: 400

错误请求

ServerPluginError

状态代码: 404

未发现

ServerPluginError

[POST] /api/v2/common/documents/{id}/restore

恢复文档。

参数

名称	类型	位置	描述
id必填项	string	path	文档ID。 例如：1E5D7247-450E-4383-B0DD-09D5CF651907

响应

状态代码: 200

成功

DocumentResponseModel

状态代码: 400

错误请求

ServerPluginError

[POST] /api/v2/common/documents/batch-restore

批量恢复文档。

请求模式

DocumentModel+BatchRestoreDocumentsRequestModel

响应

状态代码: 200

成功

DocumentResponseModel

状态代码: 400

错误请求

ServerPluginError

[PUT] /api/v2/common/documents/{id}/properties/update

更新文档属性

参数

名称	类型	位置	描述
id必填项	string	path	文档ID。 例如：1E5D7247-450E-4383-B0DD-09D5CF651907

请求模式

DocumentModel+DocumentPropertyRequestModel

响应

状态代码: 200

成功

DocumentResponseModel

状态代码: 400

错误请求

ServerPluginError

状态代码: 404

未发现

ServerPluginError

[PUT] /api/v2/common/documents/batch-hide-in-document-portal/update

在文档门户中批量隐藏文档。

请求模式

DocumentModel+BatchHideDocumentInDocumentPortalRequestModel

响应

状态代码: 200

成功

BatchHideDocumentInDocumentPortalReponseModel

状态代码: 400

错误请求

ServerPluginError

[POST] /api/v2/common/documents/{id}/copy

复制文档。

参数

名称	类型	位置	描述
id必填项	string	path	文档ID。 例如：1E5D7247-450E-4383-B0DD-09D5CF651907

请求模式

DocumentModel+CopyDocumentRequestModel

响应

状态代码: 200

成功

DocumentResponseModel

状态代码: 400

错误请求

ServerPluginError

状态代码: 404

未发现

ServerPluginError

[POST] /api/v2/common/documents/export

输出文档及其参考资料。

请求模式

ExportRequestModel

响应

状态代码: 200

成功

二进制

状态代码: 400

错误请求

ServerPluginError

[POST] /api/v2/common/documents/import

导入文档。

响应

状态代码: 200

成功

ImportResult

状态代码: 400

错误请求

ServerPluginError

[POST] /api/v2/common/documents/upload

上传文档。

响应

状态代码: 200

成功

QueueStatsResponseModel

状态代码: 400

错误请求

ServerPluginError

模型定义

Ƭ ServerPluginError

服务器插件错误

名称	类型	描述	示例
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文
innerError	ServerPluginError

Ƭ ThumbnailUploadResponseModel

上传文档缩略图的响应模式。

名称	类型	描述	示例
thumbnailUrl可为空	string	文档缩略图 url。

Ƭ DocumentResponseModel

文档响应模式

名称	类型	描述	示例
documentId可为空	string	文档ID
title可为空	string	文档标题
fileExt可为空	string	文档文档扩展名
contentType可为空	string	文档内容类型
creatorName可为空	string	文档创建者姓名
modifierName可为空	string	文档修饰符名称
deleterName可为空	string	文档删除者姓名
description可为空	string	文档说明
isSystemReserved可为空	Boolean	文档是否为系统保留
isResource	Boolean	Whether document is resource
hideOnMobile可为空	Boolean	在移动设备上隐藏文档
meta可为空	string	文档元数据
hideInDocumentPortal可为空	Boolean	在文档门户中隐藏文档
organizationId可为空	string	文档组织 ID
organizationIdPath可为空	string	文档组织ID路径
thumbnail可为空	string	文档缩略图
schemaVersion可为空	string	文档架构版本

Ƭ DocumentModel+DocumentDeleteRequestModel

文档删除信息

名称	类型	描述	示例
force	Boolean	是否强制删除文档	true
permanent	Boolean	是否永久删除文档	true

Ƭ DocumentModel+BatchDeleteDocumentsRequestModel

批量删除的文档信息

名称	类型	描述	示例
documentIds	Array<string>	批量操作文档id	["F00FC3E6-8554-467D-9A7E-4598E623BB2F","F00FC3E6-8554-467D-9A7E-4598E623BB2D"]
force	Boolean	是否强制删除文档
permanent	Boolean	是否永久删除文档

Ƭ DocumentModel+BatchRestoreDocumentsRequestModel

批量恢复的文档信息

名称	类型	描述	示例
documentIds	Array<string>	批量操作文档id	["F00FC3E6-8554-467D-9A7E-4598E623BB2F","F00FC3E6-8554-467D-9A7E-4598E623BB2D"]

Ƭ DocumentModel+DocumentPropertyRequestModel

文档属性

名称	类型	描述	示例
newName可为空	string	新文档名称	"newDocument"
meta可为空	string	文档元数据	"DSC_PROVIDER=CSV"
description可为空	string	文档说明	"Document Description"
fontOriginalName可为空	string	字体文档原始名称	"Oswald"
hideOnMobile可为空	Boolean	是否在移动端隐藏文档
hideInDocumentPortal可为空	Boolean	是否在文档门户中隐藏文档

Ƭ BatchHideDocumentInDocumentPortalReponseModel

在文档门户中批量隐藏文档

名称	类型	描述	示例
updated_Document_Ids可为空	Array<string>	更新了文档ID。
updated_Failed_Documents可为空	UpdateFailedInfo	更新失败的文档。

Ƭ UpdateFailedInfo

更新隐藏文档失败的信息

名称	类型	描述	示例
documentIds可为空	Array<string>	文档编号列表
error	ServerPluginError

Ƭ DocumentModel+BatchHideDocumentInDocumentPortalRequestModel

在文档门户中批量隐藏文档信息

名称	类型	描述	示例
documentIds	Array<string>	批量操作文档id	["F00FC3E6-8554-467D-9A7E-4598E623BB2F","F00FC3E6-8554-467D-9A7E-4598E623BB2D"]
hideInDocumentPortal	Boolean	文档入口是否隐藏文档

Ƭ DocumentModel+CopyDocumentRequestModel

复制文档的基本信息。

名称	类型	描述	示例
newDocName	string	New document name	"newDocumentName"
currentTagId可为空	string	当前标签 ID	"D01EF9CA-48A2-4ABA-B54E-AD9DA89955F3"
copyAsTemplate	Boolean	是否将文档复制为模板

Ƭ ExportRequestModel

表示导出模型。

名称	类型	描述	示例
items	ExportItemModel	需要导出的项目。
includeDocumentPermissions	Boolean	导出文档时是否包含文档的权限，默认为false。	true
excludeReferenceDocumentTypes可为空	Array<string>	不允许导出的参考文档的文档类型， 它的优先级高于参数 'IncludeReferenceDocumentTypes'.	["dst","dbd"]
includeReferenceDocumentTypes可为空	Array<string>	允许导出的参考文档的文档类型， 它的优先级低于参数 'ExcludeReferenceDocumentTypes'.	["dst","dbd"]

Ƭ ExportItemModel

表示导出项模型。

名称	类型	描述	示例
type	string	需要导出的项目类型，有效类型为: "$$documents" -> 文档, "sys-conf-ui" -> UI设置, "sys-cat" -> 类别, "sys-clp" -> 自定义语言包, "sys-ctheme" ->自定义主题, "sys-et" -> 导出模板, "sys-role" -> 角色, "sys-st" -> 明细表模板, "sys-secprovider" -> 安全提供者, "sys-secset" -> 安全设置, "sys-uf" -> 用户功能, "sys-conf-wq" ->工作队列设置, "auditLogConfiguration" -> 日志审核设置, "sys-conf-dashboard-common" ->仪表盘常见设置, "sys-conf-dashboard-designer" -> 仪表板设计器设置, "sys-conf-dashboard-view" -> 仪表板视图设置, "sys-conf-ddt" -> 默认文档主题, "sys-conf-es" -> 邮件设置, "sys-conf-rs" -> 报表设置, "sys-conf-ss" -> 计划设置,	"sys-conf-ui"
items	Array<string>	需要导出的项目。	["1FB74CF4-FFB0-492F-A2D5-29AA761955CF","DD695D78-015D-43E2-9F3A-8919F4F534FE"]

Ƭ ImportResult

表示导入结果模型。

名称	类型	描述	示例
documents可为空	DocumentImportResult	导出设置
settings可为空	UploadSetting	导入的设置。

Ƭ DocumentImportResult

表示文档导入结果模型。

名称	类型	描述	示例
success	Boolean	文档导入结果。
operation	DocumentOperation
error	ImportError
document	UploadDocument

Ƭ UploadSetting

表示上载设置模型。

名称	类型	描述	示例
name可为空	string	设置名称。
type可为空	string	设置类型。

Ƭ DocumentOperation

Enum:

• Add
• Update
• Ignore
• Upgrade

47 / 5,000 导入文档操作类型的枚举。

* Add - 0 - 添加文档。
* Update - 1 - 更新文档。
* Ignore - 3 - 忽略文档。
* Upgrade - 4 - 升级文档。

Ƭ ImportError

名称	类型	描述	示例
errorCode	int32
errorText可为空	string
context可为空	any

Ƭ UploadDocument

代表一个上传的文档模型。

名称	类型	描述	示例
id可为空	string	文档 ID。
title可为空	string	文档标题。
documentType可为空	string	文档类型。
fileExt可为空	string	文档文档的扩展名。
contentType可为空	string	文档内容类型。
createdBy可为空	string	文档创建者。
modifiedBy可为空	string	文档编辑器。
created可为空	ISO DateTime Sting	文档创建时间。
modified可为空	ISO DateTime Sting	文档修改时间。

Ƭ QueueStatsResponseModel

表示队列统计响应模型。

名称	类型	描述	示例
workers可为空	WorkerInfo	人员信息列表。
tasks可为空	CommonTaskInfo	任务信息列表。

Ƭ WorkerInfo

名称	类型	描述	示例
id可为空	string
url可为空	string
lastSeen	ISO DateTime Sting
tasksInProgress	int32
displayName可为空	string
specializations可为空	Array<string>

Ƭ CommonTaskInfo

表示通用的任务信息响应模型。

名称	类型	描述	示例
taskID	TaskID
workerUrl可为空	string	工作url。
workerID可为空	string	工作人员id。
initiator可为空	string	任务启动器。
documentName可为空	string	文档名称。
documentId可为空	string	文档id。
documentType可为空	string	文档类型。
startTime	ISO DateTime Sting	Get or set task start time.
endTime可为空	ISO DateTime Sting	任务结束时间。
progress可为空	string	任务进度。
errorMessage可为空	string	任务错误消息。
description可为空	string	任务描述。
breakStatus	CommonTaskInfo+TaskStatus
status	CommonTaskInfo+TaskStatus
type	CommonTaskInfo+TaskType

Ƭ TaskID

名称	类型	描述	示例
parent	TaskID
id可为空	string

Ƭ CommonTaskInfo+TaskStatus

Enum:

• NotStarted
• WaitingForActivation
• WaitingToRun
• Started
• ReadingResult
• Verifying
• Canceled
• Failed
• Finished

任务状态枚举

* NotStarted - 0 - 未启动。
* WaitingForActivation - 1 - 等待激活。
* WaitingToRun - 2 - 等待运行。
* Started - 3 - 开始。
* ReadingResult - 4 - 读取结果。
* Verifying - 5 - 核实。
* Canceled - 6 - 取消。
* Failed - 7 - 失败。
* Finished - 8 - 完成。

Ƭ CommonTaskInfo+TaskType

Enum:

• Queue
• Scheduler

任务类型的枚举。

* Queue - 0 - 队列任务。
* Scheduler - 1 - 调度程序任务。